/**
 * Copyright (c) 2008, Fabien Antoine
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE HAXE PROJECT CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE HAXE PROJECT CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

package fas.massload.file;

import flash.events.IEventDispatcher;

interface ILoadFile implements IEventDispatcher
{
	// ------- //
	// Methods //
	// ------- //
	
	/**
	 * Start the loading
	 */
	function load():Void;
	
	/**
	 * Stop the loading
	 */
	function close( ?error:Bool=false ):Void;
	
	/**
	 * String version of the LoadFile
	 */
	function toString():String;
	
	
	
	// --------- //
	// Accessors //
	// --------- //
	
	/**
	 * State of loading
	 */
	var loading( default, null ):Bool;
	
	/**
	 * LoadFile's type:
	 * - Loader
	 * - UrlLoader
	 * - Group of Loaders and/or UrlLoaders
	 */
	var type( default, null ):FileType;
	
	/**
	 * LoadFile's name
	 */
	var name( default, default ):String;
	
	/**
	 * Number of bytes loaded
	 */
	var bytesLoaded( getBytesLoaded, null ):UInt;
	
	/**
	 * Total number of bytes
	 */
	var bytesTotal( getBytesTotal, null ):UInt;
	
	/**
	 * Data received
	 */
	var content( getContent, null ):Dynamic;
}

enum FileType
{
	Loader;
	UrlLoader;
	SoundLoader;
	GroupLoader;
}